home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / sbrain1.zip / SBRAIN.DOC < prev    next >
Text File  |  1993-03-14  |  21KB  |  523 lines
  1. 3/14/93
  2.                           THE BRAINEX SHOP MASTER
  3.                      A Credit Card Orders/Subcription Door
  4.                       (C) Copyright 1992 by Stanley Sheff
  5.                         Support BBS: The Brainex System
  6.                                (310) 275-2344
  7.                                (310) 273-5234
  8.  
  9.    > This door requires the Brainex Door Manager. If you have not done so, 
  10.    > please install The Door Manager BEFORE you attempt to setup this door.
  11.    > Be sure that your BRAINEX.DAT is dated on or after the date of
  12.    > SBRAIN.EXE.
  13.    
  14.    Welcome to the Shop Master.  This door allows your callers to upgrade
  15.    their subscriptions and levels or order products using a VISA, MASTER CARD,
  16.    AMERICAN EXPRESS, DINER'S CLUB, CARTE BLANCHE or DISCOVER CARD.
  17.  
  18.    Shop Master also allows payment by CHECK, MONEY ORDER or C.O.D..
  19.  
  20.    Shop Master creates it's own online product catalog, which may 
  21.    be downloaded or viewed online.
  22.    
  23.    * If you are a Teleflora Creditline user, Shop Master will work
  24.    * with TelePC to verify user's orders online, or after they log off
  25.    * the BBS. Amounts charged can be directly deposited into your
  26.    * checking account! For more information, read TELEPC.DOC.
  27.   
  28.    Shop Master will write an invoice file with all the information needed 
  29.    to process a credit card order.  Shop Master will check for a valid 
  30.    credit card number, but you will be required to verify the account 
  31.    by phone.
  32.  
  33.    GAP & PCBoard BBS: The door will automatically upgrade the user's 
  34.    level and subscription date online.
  35.  
  36.    PCBoard needs to write DOOR.SYS and USERS.SYS when running the door.
  37.    Shop Master updates DOOR.SYS for GAP or any DOOR.SYS type BBS. 
  38.    USERS.SYS is updated for PCBoard.
  39.    
  40.    
  41.    =====================================================================
  42.    If you have registered ORDER BRAIN before December 10, 1992, you can 
  43.    switch to The Shop Master at NO COST.  First, you will need to convert 
  44.    your ORDER.DAT file to CATALOG.DAT. Run the included CONVERT.EXE.  
  45.    Next, call the Brainex System, and post your BBS Name and Registration 
  46.    number in private mail to the SYSOP.  You will be issued a Shop Master 
  47.    registration number.  If you register ORDER after December 10, 1992,
  48.    you may apply your $25 Order Brain registration fee toward the purchase 
  49.    of The Shop Master. This makes the cost to switch only $20. 
  50.    =====================================================================
  51.    
  52.  
  53.     The Shop Master Files
  54.     ---------------------
  55.     SBRAIN.EXE   <------------------ The Shop Master Program
  56.     SBRAIN.DOC   <------------------ Sysop's Information
  57.     SBRAIN.HLP   <------------------ Online Door Help
  58.     CONVERT.EXE  <------------------ Converts ORDER.DAT to CATALOG.DAT
  59.     REGISTER.DOC <------------------ Registration information
  60.     PRODUCTS.DOC <------------------ Latest Brainex Products!
  61.     TELEPC.DOC   <------------------ CreditLine Information (Registered Version)
  62.     INVOICE.TXT  <------------------ Sysop's Invoice Template
  63.     RECEIPT.TXT  <------------------ Customer's Receipt Template
  64.     DEALS        <------------------ ASCII Special Deals
  65.     DEALSG       <------------------ ANSI Special Deals 
  66.     HAGGLE       <------------------ Haggle Data File
  67.     HELLOG       <------------------ ASCII "Use Door?" screen
  68.     HELLO        <------------------ ANSI  "Use Door?" screen 
  69.     INFO         <------------------ ASCII General Help File
  70.     INFOG        <------------------ ANSI  General Help FIle
  71.     LEVEL        <------------------ ASCII Invalid Level Notice
  72.     LEVELG       <------------------ ANSI  Invalid Level Notice
  73.     MENU         <------------------ ASCII Order Options/Prices
  74.     MENUG        <------------------ ANSI  Order Options/Prices
  75.     NOTICE       <------------------ ASCII Warning Notice
  76.     NOTICEG      <------------------ ANSI Warning Notice
  77.     SUB          <------------------ ASCII Subscription Thank You File
  78.     SUBG         <------------------ ANSI Subscription Thank You File
  79.     THANKS       <------------------ ASCII Thank You (shown after an order)
  80.     THANKSG      <------------------ ANSI Thank You (shown after an order) 
  81.     FILE_ID.DIZ  <------------------ Short Door Description
  82.     SETUP.BAT    <------------------ Door Installer Batch File
  83.  
  84.  
  85.    NOTE-> If you have edited an ANSI info file and see a "MORE - Yes, No,..." 
  86.           prompt, you can either save the file with a longer line length (255)
  87.           or use a text editor to insert a { character on the first line 
  88.           of the file. This disables the "MORE - Yes, No,..." prompt when 
  89.           the file is shown by the door.
  90.        
  91.    All of these files should be in this ZIP, if they are not, don't
  92.    take a chance! Call The Brainex System and get a good copy or view the 
  93.    file on a few local boards to see if you can find a complete copy.
  94.  
  95.    To install, unzip these files into a work directory, then type:
  96.    
  97.    SETUP
  98.    
  99.    A BRAINEX\SBRAIN directory will be created.
  100.    
  101.    SBRAIN.EXE will be copied to the BRAINEX directory, the rest of the
  102.    files to the BRAINEX\SBRAIN directory.
  103.  
  104.    You will then be taken to the Door Manager Door Install area. 
  105.  
  106.  
  107. Shop Master Setup Questions/Options:
  108.  
  109. Please enter your Shop Master Registration number, or 0 if unregistered.
  110.    > When registered, Shop Master will save user's orderig information
  111.    > to an ascii file you specify. Unregistered version will not save
  112.    > to disk, but will otherwise function normally.
  113.  
  114. Please enter the DRIVE\DIRECTORY\NAME of the text to write information
  115. about orders placed by callers. (Do NOT include a file extension.)
  116.    > This is the name of the file that will hold all the information
  117.    > about a user's order. If the order was processed successfully,
  118.    > an extension of YES will be used, if the order did not pass
  119.    > the verification process, an extension of NO will be used. If
  120.    > you entered C:\CREDIT\ORDER as the file name, a good order would
  121.    > be stored as C:\CREDIT\ORDER.YES.
  122.  
  123. Save order information to PRINTER?
  124.    > When an order is processed successfuly, the information can also
  125.      be sent to your printer. Answer YES to print each order.
  126.      
  127. Enter the minimum caller access level required to use this door.
  128.    > Callers with an access level below this will not be able to
  129.    > access the door. They will be shown the LEVEL file.
  130.  
  131. Enter the level and above that will bypass this door?
  132.    > This level is usually used for the sysop who has setup Shop Master
  133.    > as a "logon" door, and does not wish to see the door during logon.
  134.  
  135. Enter the Payment Methods you will allow:
  136. VISA=VS, MASTERCARD=MC, AMERICAN EXPRRSS=AM, DISCOVER=DS, DINER'S CLUB=DC, 
  137. CARTE BLANCHE=CB, JCB=JB, CHECK=Check or Money, COD=C.O.D.
  138.  
  139. When a user buys a BBS subscription, when should the
  140. user's additional subscription days begin?
  141. TODAY=New subscription period begins day of the order.
  142. EXPIRE=Add days after subscription expiration date.
  143.     > If a user buys a BBS subscription, the new time period can begin
  144.     > after the old on expires, or can begin on the day they order.
  145.     > Example: A user has 10 days left on a previous subscription, buys
  146.     > an additional 30 day subscription. If you set to TODAY, the user
  147.     > will have a total of 30 days remaining, if you set to expire,
  148.     > the user will have 30 new days added to the old 10, giving
  149.     > them a total of 40 days.
  150.     > Note: PCBoard adds additional days to the current expiration
  151.     > date, so this option will not matter.
  152.  
  153. Should Shop Master be allowed to lower a subscription level?
  154. YES=New user level can be lower than previous level
  155. NO=Only change if new level is above current level
  156.  
  157. Enter the colors for displayed text (B=Bright, BBLUE is Bright Blue)
  158. RED, GREEN, BROWN, BLUE, MAGENTA, CYAN, WHITE
  159. BBLACK, BRED, BGREEN, YELLOW, BBLUE, BMAGENTA, BCYAN, BWHITE 
  160.     > This is used for catlog text searches.
  161.  
  162. Enter the colors for search hit text (text found during searches)
  163. RED, GREEN, BROWN, BLUE, MAGENTA, CYAN, WHITE
  164. BBLACK, BRED, BGREEN, YELLOW, BBLUE, BMAGENTA, BCYAN, BWHITE 
  165.  
  166. Enter your Sales Tax Rate Percentage or NONE
  167.    > Example: 8.25
  168.  
  169. Enter your two letter State Abbreviation
  170.    > Use two letters only, do NOT add a period (CA.)
  171.    > Caller's from this state will be taxed.
  172.  
  173. Enter full State Name for tax
  174.    > Caller's from this state will be taxed.
  175.  
  176. Enter the DRIVE\DIRECTORY of Your TelePC software or }NONE
  177.    > This program will process your merchant account orders
  178.    > online without the need for a terminal! See the enclosed TELEPC.DOC 
  179.    > for information on how to obtain this software package!
  180.  
  181. Shop Master can process orders in one of two modes:
  182. ONLINE-Uses second comport/modem while caller is online.
  183.  
  184. * If you do not use TelePC, select ONLINE
  185.  
  186. OFFLINE-Processes the order after caller logs off the BBS.
  187. Select ONLINE or OFFLINE.
  188.  
  189. You may attach a TEXT FILE to user's receipts
  190. Please enter DRIVE\DIRECTORY\FILENAME.EXT or NONE.
  191.     > This should be an ASCII text file.
  192.  
  193. Enter your invoice start number. Invoices numbers will begin with this.
  194.     > Any Number
  195.  
  196. Enter the DRIVE\DIRECTORY where download files are located.
  197.     > If you want users to be able to download files using Shop Master,
  198.     > enter the directory location of the files. Enter NONE to disable 
  199.     > this option. 
  200.  
  201. Enter the DRIVE\DIRECTORY\FILENAME.EXT to your Files List (FILES.BBS)
  202.     > Complete path and filename of file description text file.
  203.     > This file uses a FILES.BBS type format. Each file should use the 
  204.     > following column format:
  205.  
  206. FILENAME            SIZE           DATE            DESCRIPTION
  207. 1<------------->13  14<------->21  24<-------->31  34<---------->78
  208.  
  209. Examples:
  210. ALADDIN.ZIP     89867  08/25/92  Aladdin's Magic Lamp Text Adventure
  211. SBRAIN.ZIP     123467  12/01/92  Shop Master - Credit Card Order Door
  212.  
  213. Would you like to allow callers to log off the BBS after downloads?
  214.     > YES or NO
  215.  
  216. Enter the Maximum Number of Minutes users may stay in the Shop Master.
  217.     > Any number from 1 to 32767
  218.  
  219. ---------------------------------------------------------------------
  220.    CATALOG.DAT file  
  221.    ================
  222.    Use an ASCII text editor to create your CATALOG.DAT file. This is
  223.    used by Shop Master to obtain specific information about the items
  224.    you will offer to your users.  
  225.  
  226.    CATALOG.DAT options:
  227.  
  228.    ITEM     - Brief Product Description
  229.    
  230.    INFOFILE - DRIVE\DIRECTORY\FILENAME.EXT of Descriptive Text File
  231.    
  232.    PRICE    - Price in Dollars and Cents format 00.00 (Don't use a $)
  233.    
  234.    TAX      - If the caller is not from out of state, tax will be
  235.               added if this option is TAX=YES
  236.    
  237.    SHIPPING - Shipping Fee in Dollars and Cents format 00.00 (Don't use a $)
  238.  
  239.    If using Shop Master for BBS subscriptions, you can use:
  240.  
  241.    LEVEL    - Upgraded user level. If the user's level is below this
  242.               level, the user will be upgraded to the indicated level.
  243.    
  244.    DAYS     - Addtional Days added to user subscription period
  245.  
  246.    End each item section with three dashes ---
  247.  
  248.    Sample CATALOG.DAT file format:
  249.    
  250.    ITEM=One Month BBS Subscription
  251.    INFOFILE=C:\BRAINEX\SBRAIN\INFO.TXT
  252.    PRICE=15.00
  253.    LEVEL=90
  254.    DAYS=30
  255.    ---
  256.  
  257.    ITEM=Night Owl CD-ROM Volume 7
  258.    INFOFILE=C:\BRAINEX\SBRAIN\CDROM.TXT
  259.    PRICE=30.00
  260.    TAX=YES
  261.    SHIPPING=2.00
  262.    ---
  263.  
  264.    ITEM=Printed BBS Manual
  265.    PRICE=2.00
  266.    ---
  267.  
  268.    You must include an item and a price. Other selections are optional.
  269.  
  270.  
  271.    INVOICE.TXT (Sysops Invoice Record) 
  272.    RECEIPT.TXT (Customer's Receipt)
  273.    =========================
  274.    These are text file templates that use special replacable commands:  
  275.    
  276.    @INVOICE                                    @CARDINFO
  277.    @DATE                                       @ADDRESS
  278.    @TIME                                       @HOMEPHONE
  279.    @VERIFICATION                               @BBSNAME
  280.    @USERNAME                                   @BBSPHONE
  281.    @TAX                                        @SHIP
  282.    @TOTAL                                      @DISC
  283.    @COD   
  284.    
  285.    After an order, Shop Master replaces these "@" commands with the 
  286.    actual user information, then writes a file to disk as the FILENAME 
  287.    you specified above (order information file). 
  288.    
  289.    RECEIPT.TXT may be read or downloaded by the user. Be sure to edit
  290.    in your BBS information!
  291.    
  292.    Please EDIT these file as you wish using any ascii text editor. 
  293.    Be sure your editor does not use CONTROL Z to terminate a line.  
  294.    The replacable parameters should be the LAST ITEM on a line 
  295.    (@DATE, @TIME, etc.). These files should be located in BRAINEX\SBRAIN.
  296.  
  297.    HELLO
  298.    =====
  299.    If you wish to ask user if they want to enter the door, add
  300.    the SKIP= to the command line. Example:
  301.    SBRAIN SKIP=110
  302.    Users with security level 110 and above will bypass the door, 
  303.    lower levels will be shown the HELLO prompt and asked if they want 
  304.    to use Shop Master.
  305.    
  306.    This is useful where Shop Master is run in a login door sequence. 
  307.    Omit this command if running the door from the BBS command prompt.
  308.  
  309.    DEALS.TXT
  310.    =========
  311.    If you wish to offer any special deals, create this file and place
  312.    it in your BRAINEX\SBRAIN directory. Optional ANSI version should
  313.    be named DEALSG.TXT
  314.  
  315.    HAGGLE   
  316.    ======
  317.    If present in the BRAINEX\SBRAIN directory, Shop Master will allow 
  318.    you to offer a discount. Users can select the [H]aggle option before
  319.    they place an order, and try to haggle a better price! You can select
  320.    the name of the "haggler", the maximum discount percentage rate offered, 
  321.    and the a choice of remarks made by the haggler to the user.
  322.  
  323.    Sample HAGGLE file:
  324.    ------------------------------------------------
  325.    MAXIMUM HAGGLE DISCOUNT=10
  326.    HAGGLER NAME=Crazy Murray
  327.    You think I'm made of money?
  328.    You'll have to do better than that, my friend!
  329.    That's not an offer, that's a joke!
  330.    Let's get real, ok?
  331.    Talk to me when you get serious...
  332.    I might be crazy, but I'm not THAT crazy!
  333.    Talk some turkey!
  334.    Hmmm... That's an interesting offer, but no deal!
  335.    -------------------------------------------------
  336.    The maximum haggle discount is a percentage, so the above example
  337.    would allow a maximum discount of 10% off the total purchase price.
  338.    The discount will be indicated in receipts and invoices with the @DISC
  339.    parameter.
  340.  
  341.    You may add as many haggle remarks as you like, just put each on
  342.    a seperate line as shown above.
  343.    
  344.    Remove the HAGGLE file from the BRAINEX\SBRAIN directory to 
  345.    disable haggling.
  346.  
  347.  
  348.    CATALOG
  349.    =======
  350.    The first time you run Shop Master, it will create two catalog files
  351.    in the BRAINEX\SBRAIN directory.
  352.    
  353.    CATALOG.STD - (Standard Catalog) Item, Price, Shipping 
  354.    
  355.    CATALOG.DLX - (Deluxe Catalog) Item, Price, Shipping, 
  356.                  Detailed Item Information
  357.                  (Derived from the text you supplied in INFOFILE=files)
  358.    
  359.    Users may View, Search, Order from the Catalog, or Download the catalog.  
  360.    
  361.   
  362.    
  363.    DOWNLOADS REQUIRE DSZ or GSZ
  364.    ============================
  365.    Place DSZ.COM or DSZ.EXE in the path. If you have an unregistered DSZ, 
  366.    Y-Modem G protocol will NOT function.  If you wish to use GSZ,
  367.    simply rename GSZ.EXE to DSZ.EXE, or you can edit the batch files
  368.    that call GSZ. They are located in the BRAINEX directory, and
  369.    are named: EXTSZ.BAT, EXTS1.BAT, etc.  You should add an environment
  370.    variable to set the dsz log file name, and if using gsz, the window
  371.    size. If the DSZLOG varible is not set, NO download logs will be
  372.    written.  See the sample batch files below.
  373.  
  374.    
  375.    RUNNING SHOP MASTER
  376.    ===================
  377.    
  378.    Once you have created your CATALOG.DAT, you must then create a a batch 
  379.    file to call the door. A batch file for a GAP BBS might look like this:
  380.    
  381.      @ECHO OFF
  382.      SET GSZWINDOW=23
  383.      SET DSZLOG=LOG1
  384.      SBRAIN
  385.      
  386.    Multinode BBSes use the NODE= command. Example:
  387.  
  388.    @ECHO OFF
  389.    SET GSZWINDOW=23
  390.    SET DSZLOG=LOG2
  391.    SBRAIN NODE=2
  392.  
  393.    
  394.    You may specify different catalogs by using CATALOG= on the command
  395.    line. If you named your CATALOG.DAT file to CAT1.DAT and placed it in
  396.    a directory called C:\CATS, the command line would look like:
  397.    
  398.    SBRAIN CATALOG=C:\CATS\CAT1.DAT
  399.    
  400.  
  401.    ========================================================================
  402.    TELEPC (Registered Version Only)
  403.    
  404.    Telepc-b.exe must be configured and working correctly. 
  405.    There are two modes of operation.
  406.  
  407.    1. Online Mode. Using a second comport and modem, Shop Master
  408.    will shell to Telepc-b.exe and process the order while the caller
  409.    waits. 
  410.  
  411.    2. Offline Mode. Shop Master will shell to Telepc-b.exe when the
  412.    user logs off the BBS.  To use the offline function, run Order
  413.    Brain with the offline option.
  414.  
  415.    SBRAIN NODE=2 OFFLINE
  416.    or
  417.    SBRAIN OFFLINE
  418.    etc.
  419.  
  420.    If you use Shop Master in OFFLINE MODE with the Telepc Program,
  421.    you will need to modify the batch file that runs your BBS:
  422.  
  423.    Sample GAP BBS Batch file (GAP.BAT) :
  424.    
  425.    @ECHO OFF
  426.    GAPMENU
  427.    IF ERRORLEVEL 99 GOTO SHOP
  428.    GOTO END
  429.    :SHOP
  430.    SBRAIN OFFLINE
  431.    GAP
  432.    :END
  433.  
  434.    Sample PCBoard Batch File (BOARD.BAT) :
  435.  
  436.    @ECHO OFF
  437.    C:
  438.    CD \PCB
  439.    SET PCB=/SWAP
  440.    SET DSZLOG=C:\PCB\PCBDSZ.LOG
  441.    IF EXIST REMOTE.BAT RENAME REMOTE.BAT REMOTE.SYS
  442.    IF EXIST EVENT.BAT RENAME EVENT.BAT EVENT.SYS
  443.    IF EXIST DOOR.BAT DEL DOOR.BAT
  444.    IF EXIST ENDPCB DEL ENDPCB
  445.    PCB145
  446.    IF EXIST REMOTE.BAT REMOTE
  447.    IF EXIST DOOR.BAT DOOR
  448.    IF EXIST EVENT.BAT EVENT
  449.    IF EXIST ENDPCB GOTO END
  450.    SBRAIN OFFLINE
  451.    BOARD
  452.    :END
  453.    EXIT
  454.    
  455.    The above modifications are only required when using The Shopping Door
  456.    in OFFLINE mode.
  457.    =======================================================================
  458.  
  459.    
  460.    The following sysop functions are available while awaiting
  461.    keyboard input :
  462.  
  463.      F5      - Shell to DOS.
  464.      F8      - Twit user and return to BBS.
  465.     F10      - Initiate chat with user.
  466.     CF10     - Answer user page bell.
  467.     Home     - Main user stats.
  468.     End      - Displays sysop keys available.
  469.     PgDn     - Secondary user stats.
  470.     Up Arrow - Increase user's time remaining by 5 minutes.
  471.     Dn Arrow - Decrease user's time remaining by 5 minutes.
  472.  
  473.    One of the nicer features about using the TWIT key, is the user
  474.    is not told that "the sysop wants them to return to the BBS".
  475.    Instead, a very plain and simple message of "returning you to the
  476.    BBS" is displayed.  This way, the user is given no indication
  477.    that the sysop is hovering about.
  478.  
  479.    When using the F5 shell to DOS key, to return to the door
  480.    program, simply type EXIT at the DOS command prompt. It is not
  481.    necessary to change directories back to the door directory.
  482.    The Shop Master is smart enough to know which drive and directory the
  483.    door program is in and will reset the defaults upon return from
  484.    DOS.
  485.  
  486.    The Up and Down Arrow keys increase and decrease the user's time
  487.    respectively by 5 minutes for each press of the key. There is no
  488.    indication of what is occurring (except by the fact the user's
  489.    time remaining will change), so the sysop should try not to have
  490.    a lead finger. The increase or decrease is effective only while
  491.    the user is in The Shop Master.
  492.  
  493.                                --  --  --
  494.  
  495.    
  496.    This version of The Shop Master is a DEMO. 
  497.    
  498.    No orders will be processed or written to file.
  499.  
  500.    It will become full featured upon registration. This door is released 
  501.    "As Is" and there is *NO* warranty or guarantee that it will work for 
  502.    you and not cause any problems. You have chosen to use this door, YOU 
  503.    are responsible for any unfortunate problems that may develop from its 
  504.    use or misuse. I will gladly listen to any suggestions or problems you 
  505.    may have, and I will do my best to fix whatever needs to be fixed. 
  506.    I can not be held responsible for any problems you may have, whether 
  507.    directly or indirectly due to the use of the door.
  508.    
  509.    Please read REGISTER.DOC for information on how you can register
  510.    your copy of The Shop Master. 
  511.  
  512.    For complete support, contact me on The Brainex System.
  513.    Your questions will be quickly and cheerfully answered!
  514.  
  515.  
  516.    Have Fun!
  517.    Stanley Sheff
  518.    The Brainex System
  519.    310-275-2344 HST
  520.    310-273-5234 V.32bis
  521.  
  522.    Voice Support for Registered Sysops!
  523.